Skip to content

Rephrase following command (part 1) #4283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 22, 2025
Merged

Rephrase following command (part 1) #4283

merged 1 commit into from
Sep 22, 2025

Conversation

maximiliankolb
Copy link
Contributor

What changes are you introducing?

Rephrase "run the following command" to something more descriptive.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

Because I don't like reading "run this command" all the time & it should improve UX if we have more descriptive introductions to code blocks: Users will know what happens if the copy&paste commands.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Part of #3672 on GitHub

Contributor checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.16/Katello 4.18 (Satellite 6.18)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4)
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9; orcharhino 7.1 with Leapp)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • We do not accept PRs for Foreman older than 3.9.

Review checklists

Tech review (performed by an Engineer who did not author the PR; can be skipped if tech review is unnecessary):

  • The PR documents a recommended, user-friendly path.
  • The PR removes steps that have been made unnecessary or obsolete.
  • Any steps introduced or updated in the PR have been tested to confirm that they lead to the documented end result.

Style review (by a Technical Writer who did not author the PR):

  • The PR conforms with the team's style guidelines.
  • The PR introduces documentation that describes a user story rather than a product feature.

@github-actions github-actions bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Sep 19, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 19, 2025 •
edited
Loading

The PR preview for 9a261c0 is available at theforeman-foreman-documentation-preview-pr-4283.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

aneta-petrova
aneta-petrova approved these changes Sep 22, 2025
View reviewed changes
Copy link
Member

@aneta-petrova aneta-petrova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I check the new wording and where I felt it necessary also checked that the new descriptions correspond to the commands. Looks okay! Just one small suggestion.

@maximiliankolb maximiliankolb force-pushed the fix_3672_following_command branch from d44f052 to 9a261c0 Compare September 22, 2025 11:04
maximiliankolb
maximiliankolb commented Sep 22, 2025
View reviewed changes
Copy link
Contributor Author

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I applied your suggestion.

@maximiliankolb maximiliankolb added style review done No issues from docs style/grammar perspective and removed Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Sep 22, 2025
@maximiliankolb maximiliankolb merged commit dda3441 into theforeman:master Sep 22, 2025
8 of 10 checks passed
@maximiliankolb maximiliankolb deleted the fix_3672_following_command branch September 22, 2025 11:37
maximiliankolb added a commit that referenced this pull request Sep 22, 2025
@maximiliankolb
Rephrase following command (#4283)
1a70a01 
Part of #3672 on GitHub

(cherry picked from commit dda3441)
@maximiliankolb
Copy link
Contributor Author

Rewords do not require tech reviews -> Merging.

Merged to "master" and cherry-picked:
81f1903..1a70a01 3.16 -> 3.16

maximiliankolb added a commit to ATIX-AG/foreman-documentation that referenced this pull request Sep 23, 2025
@maximiliankolb
Rephrase following command
9253491 
Extends PR theforeman#4283
Part of theforeman#3672 on GitHub
@maximiliankolb maximiliankolb mentioned this pull request Sep 23, 2025
Merged
10 tasks
maximiliankolb added a commit that referenced this pull request Sep 26, 2025
@maximiliankolb
Rephrase following command (#4292)
d91a922 
Extends PR #4283
Part of #3672 on GitHub
maximiliankolb added a commit that referenced this pull request Sep 26, 2025
@maximiliankolb
Rephrase following command (#4292)
c97ce08 
Extends PR #4283
Part of #3672 on GitHub

(cherry picked from commit d91a922)
maximiliankolb added a commit to ATIX-AG/foreman-documentation that referenced this pull request Sep 26, 2025
@maximiliankolb
Reword following command
2ea7d6f 
$ fd -e adoc . guides/common/modules | sort -u | grep -v "guides/common/modules/con_managing-ostree-content.adoc" | rg -v "guides/common/modules/proc_changing-the-method-the-bootstrap-script-uses-to-download-the-consumer-rpm.adoc" | rg -v "guides/common/modules/proc_registering-hosts-by-using-the-bootstrap-script.adoc" | rg -v "guides/common/modules/proc_creating-custom-rhel-images.adoc" | rg -v "guides/common/modules/proc_enabling-remote-execution-on-the-host.adoc" | rg -v "guides/common/modules/proc_registering-clients-using-the-bootstrap-script.adoc" | rg -v "guides/common/modules/proc_enabling-power-management-on-hosts.adoc" | rg -v "guides/common/modules/proc_providing-an-alternative-fqdn-for-the-host.adoc" | rg -v "guides/common/modules/con_managing-ostree-content.adoc" | xargs rg "following command"

This patch is the third part.

Extends PR theforeman#4283
Extends PR theforeman#4292

Fixes theforeman#3672
@maximiliankolb maximiliankolb mentioned this pull request Sep 26, 2025
Merged
10 tasks
maximiliankolb added a commit to ATIX-AG/foreman-documentation that referenced this pull request Sep 26, 2025
@maximiliankolb
Reword following command
3296285 
$ fd -e adoc . guides/common/modules | sort -u | grep -v "guides/common/modules/con_managing-ostree-content.adoc" | rg -v "guides/common/modules/proc_changing-the-method-the-bootstrap-script-uses-to-download-the-consumer-rpm.adoc" | rg -v "guides/common/modules/proc_registering-hosts-by-using-the-bootstrap-script.adoc" | rg -v "guides/common/modules/proc_creating-custom-rhel-images.adoc" | rg -v "guides/common/modules/proc_enabling-remote-execution-on-the-host.adoc" | rg -v "guides/common/modules/proc_registering-clients-using-the-bootstrap-script.adoc" | rg -v "guides/common/modules/proc_enabling-power-management-on-hosts.adoc" | rg -v "guides/common/modules/proc_providing-an-alternative-fqdn-for-the-host.adoc" | rg -v "guides/common/modules/con_managing-ostree-content.adoc" | xargs rg "following command"

This patch is the third part.

Extends PR theforeman#4283
Extends PR theforeman#4292

Fixes theforeman#3672
Lennonka pushed a commit that referenced this pull request Sep 30, 2025
@maximiliankolb
Reword following command (#4310)
26be3be 
$ fd -e adoc . guides/common/modules | sort -u | grep -v "guides/common/modules/con_managing-ostree-content.adoc" | rg -v "guides/common/modules/proc_changing-the-method-the-bootstrap-script-uses-to-download-the-consumer-rpm.adoc" | rg -v "guides/common/modules/proc_registering-hosts-by-using-the-bootstrap-script.adoc" | rg -v "guides/common/modules/proc_creating-custom-rhel-images.adoc" | rg -v "guides/common/modules/proc_enabling-remote-execution-on-the-host.adoc" | rg -v "guides/common/modules/proc_registering-clients-using-the-bootstrap-script.adoc" | rg -v "guides/common/modules/proc_enabling-power-management-on-hosts.adoc" | rg -v "guides/common/modules/proc_providing-an-alternative-fqdn-for-the-host.adoc" | rg -v "guides/common/modules/con_managing-ostree-content.adoc" | xargs rg "following command"

This patch is the third part.

Extends PR #4283
Extends PR #4292

Fixes #3672
Lennonka pushed a commit that referenced this pull request Sep 30, 2025
@maximiliankolb @Lennonka
Reword following command (#4310)
44eae9c 
$ fd -e adoc . guides/common/modules | sort -u | grep -v "guides/common/modules/con_managing-ostree-content.adoc" | rg -v "guides/common/modules/proc_changing-the-method-the-bootstrap-script-uses-to-download-the-consumer-rpm.adoc" | rg -v "guides/common/modules/proc_registering-hosts-by-using-the-bootstrap-script.adoc" | rg -v "guides/common/modules/proc_creating-custom-rhel-images.adoc" | rg -v "guides/common/modules/proc_enabling-remote-execution-on-the-host.adoc" | rg -v "guides/common/modules/proc_registering-clients-using-the-bootstrap-script.adoc" | rg -v "guides/common/modules/proc_enabling-power-management-on-hosts.adoc" | rg -v "guides/common/modules/proc_providing-an-alternative-fqdn-for-the-host.adoc" | rg -v "guides/common/modules/con_managing-ostree-content.adoc" | xargs rg "following command"

This patch is the third part.

Extends PR #4283
Extends PR #4292

Fixes #3672
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aneta-petrova aneta-petrova aneta-petrova approved these changes

Assignees
No one assigned
Labels
style review done No issues from docs style/grammar perspective
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@maximiliankolb @aneta-petrova